GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves attachments for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
includeContent |
Include the file contents of the attachments |
boolean |
Default value is False |
take |
Number of attachments to retrieve. Default is all attachments |
integer |
None. |
skip |
Number of attachments to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the attachments before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of attachments.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Attachment |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AttachmentId": "ceb3d661-6776-44f6-9f46-c88ef7505e16", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "a2af5f5e-a828-422e-9c4c-e63d06506efb", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "13d7f39f-ac1c-4e88-ad6f-16aec2b82d38", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b39d55ed-0c79-4b57-ae85-a92071b967d4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7f2ee5a5-cbd1-4e9b-b056-6818a5b3f37e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f8749824-1411-4d84-bef5-7fad142a7d9d", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "17c0970a-328e-47e1-b68e-14babe8c1033", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "MeasurementValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ebd0b98a-117a-4a2b-9e6d-5a60c61f334f", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "MeasurementValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "540394a4-c8a5-43c5-b79c-bf7df2ae00bc", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-05-03T23:31:52.4539523-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "6144acbb-b379-4959-a79e-ed3f8077a330", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "ceb3d661-6776-44f6-9f46-c88ef7505e16", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "a2af5f5e-a828-422e-9c4c-e63d06506efb", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "13d7f39f-ac1c-4e88-ad6f-16aec2b82d38", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b39d55ed-0c79-4b57-ae85-a92071b967d4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7f2ee5a5-cbd1-4e9b-b056-6818a5b3f37e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f8749824-1411-4d84-bef5-7fad142a7d9d", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "17c0970a-328e-47e1-b68e-14babe8c1033", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "MeasurementValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ebd0b98a-117a-4a2b-9e6d-5a60c61f334f", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "MeasurementValueNeededDate": "2024-05-03T23:31:52.4539523-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "540394a4-c8a5-43c5-b79c-bf7df2ae00bc", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-05-03T23:31:52.4539523-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "6144acbb-b379-4959-a79e-ed3f8077a330", "CreateDate": "2024-05-03T23:31:52.4539523-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-03T23:31:52.4539523-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }